--- title: "15-API 开放平台简历写法" created: 2025-12-02 tags: - 项目 aliases: - API 开放平台简历写法 --- # API 开放平台简历写法 ## **建议** 注意,以下简历写法仅供参考,根据你自己的简历丰富度、以及对于项目的理解情况有选择地去写。如果你自己还没有实现项目或者不理解,建议赶紧跟着鱼皮的教程把它弄懂,再写到简历上! 此外,API 开放平台项目中的 API 签名认证、Starter SDK 编写、接口调用统计、网关思想,其实是可以运用到你做的其他项目中的,可以把该项目的部分亮点和你之前的项目进行整合。 > 简历参考,写同款: ![[mhdJktwBBMqHs420-b88a7ba1.webp]] ## 专业技能 ### 后端 1. 熟悉 Java 知识(如集合类、异常处理),能熟练运用 Lambda 表达式、Hutool、Apache Utils 编程 2. 熟悉 SSM + Spring Boot 开发框架,能够使用 MyBatis Plus + MyBatis X 自动生成基础 CRUD 代码 3. 熟悉 MySQL 数据库及库表设计,能够通过创建索引、Explain 分析等方式优化性能 4. 熟悉常见的业务开发场景:比如API 签名认证、用户权限管理、Spring Boot Starter SDK 开发等 5. 熟悉 Nacos 和 Dubbo RPC 框架,能使用 Spring Cloud Gateway 实现 API 网关、访问控制 6. 熟练使用 Git、IDEA、ChatGPT、Swagger、Navicat 等工具提高开发协作效率 ### 前端 - 熟悉 React 框架开发,能够根据业务定制前端模板,比如封装全局异常处理逻辑、多环境配置等 - 熟悉前端代码规范,并能够使用 ESLint + Prettier + TypeScript + Husky 等技术保证前端项目质量。 - 熟悉 Ant Design、Echarts、Lodash 等组件库和工具的使用 - 能够使用 Ant Design Pro 框架、Umi OpenAPI 代码生成、VS Code、WebStorm IDE 等开发工具快速开发前端项目 ## 项目经历 项目名称:XX API 开放平台 建议自己想个有区分度的名字,其他名称参考: - XX 接口 - XX 接口平台 - XX 免费接口平台 - XX API - 接口一站通 在线访问:xxx(建议自己部署一下,提供可访问的、简短的线上地址) GitHub:xxx(建议把项目放到代码仓库中,并且在主页文档里补充项目信息) ### 项目介绍 基于 React + Spring Boot + Dubbo + Gateway 的 API 接口开放调用平台。 管理员可以接入并发布接口,可视化各接口调用情况;用户可以开通接口调用权限、浏览接口及在线调试,并通过客户端 SDK 轻松调用接口。 ### **主要工作** > 根据自己的方向选择去写并适当调整文案,灵活一点。 强烈建议结合下面的扩展思路多完善下项目,增加一些区分度! #### 后端 1. 根据业务流程,将整个项目后端划分为 web 系统、模拟接口、公共模块、客户端 SDK、API 网关这 5 个子项目,并使用 Maven 进行多模块依赖管理和打包。 2. 使用 Ant Design Pro 脚手架 + 自建 Spring Boot 项目模板快速构建初始 web 项目,并实现了前后端统一权限管理、多环境切换等基础能力。 3. 基于 MyBatis Plus 框架的 QueryWrapper 实现对 MySQL 数据库的灵活查询,并配合 MyBatis X 插件自动生成后端 CRUD 基础代码,减少重复工作。 4. 前端:后端使用 Swagger + Knife4j 自动生成 OpenAPI 规范的接口文档,前端在此基础上使用插件自动生成接口请求代码,降低前后端协作成本。 5. 为防止接口被恶意调用,设计 API 签名认证算法,为用户分配唯一 ak / sk 以鉴权,保障调用的安全性、可溯源性(指便于统计接口调用次数)。 6. 为解决开发者调用成本过高的问题(须自己使用 HTTP + 封装签名去调用接口,平均 20 行左右代码),基于 Spring Boot Starter 开发了客户端 SDK, **一行代码** 即可调用接口,提高开发体验。 7. 选用 Spring Cloud Gateway 作为 API 网关,实现了路由转发、访问控制、流量染色,并集中处理签名校验、请求参数校验、接口调用统计等业务逻辑,提高安全性的同时、便于系统开发维护。(更多 API 网关的优点参考:) 8. 为解决多个子系统内代码大量重复的问题,抽象模型层和业务层代码为公共模块,并使用 Dubbo RPC 框架实现子系统间的高性能接口调用(实测单机 qps 达 xx),大幅减少重复代码。 #### 前端 > 和用户中心项目前端类似 1. 使用 ECharts(或 AntV)可视化库实现了接口调用的分析图表(如饼图),并通过 loading 配置提高加载体验。 2. 为了提高开发效率,选用 Ant Design Pro 脚手架快速搭建基础页面,并对原始模板进行瘦身、抽象为可复用的公共模板,便于后续同类项目的快速研发。 3. 在脚手架自带的 umi-request 请求库基础上进行改造和封装,添加全局请求拦截和全局异常处理逻辑、自动根据项目启动命令来区分环境,减少重复代码、提升项目可维护性。 ### **扩展思路** > 需要大家自行实现 #### 前端 1. 参考 Swagger(或 Postman)等 API 管理产品实现了 API 文档浏览及在线调用功能,并提供多级联动表单来提升用户输入请求参数 json 的体验。 2. 阅读 Ant Design Pro 的文档,从框架的特性出发、结合自己做的功能去写一些亮点。 #### 后端 1. 如果项目已上线且提供了一些 API 接口,可以说:自主开发了 XX、XX 等 API 接口并接入系统,累积调用次数达 xx 次,且接口调用可用性达 99.999%(4 - 5 个 9 都可以) 2. 客户端 SDK 尽量使用最少的依赖,可以补充提一些 SDK 设计的亮点,比如:基于 Spring Boot Starter,自主设计客户端 SDK,并遵循 xx、xx、xx 等规范,保证了 SDK 的精简、避免依赖冲突。 3. 使用 Docker 或 Docker Compose 来部署项目,可以写:自主编写 Dockerfile,并通过第三方容器托管平台实现自动化镜像构建及容器部署,提高部署上线效率。 4. 思考如何保证接口调用的性能、稳定性和可用性(比如在网关增加限流 / 降级保护)? 5. 思考如何提高开发者接入平台的效率、安全性等,真正地让平台成为开放平台。 6. 可以考虑在微服务网关前搭建 Nginx 网关,通过负载均衡实现更大的并发。 7. 在数据量大的情况下,使用 Spring Scheduler 定时任务离线计算结果集来替代实时查询,提高了后端统计分析的性能,单次查询响应时长从 xx 降低至 xx。 ## 个人评价 1. 有较强的文档阅读能力,曾自主阅读 Spring Cloud Gateway、Dubbo(Ant Design Pro)等官方文档并能够运用到项目中。 2. 有较强的问题解决能力,能够利用 GitHub Issues 区、AI 工具、搜索引擎、Stack Overflow 等自主解决问题 --- **项目分区导航**:⬅️ [[14-项目笔记(四)|14-项目笔记(四)]] | 15-API 开放平台简历写法 | ➡️ [[16-API 开放平台面试题 - API 开放项目项目教程 - 编程导航教程|16-API 开放平台面试题 - API 开放项目项目教程 - 编程导航教程]]